<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Auth</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Auth</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Nexista Auth model is setup to allow user specified handlers to be used  in order to provide whatever functionality is desired. A developer can setup  their preferred authentication system and hook it into the nexista core.</p>
<p class="description"><p>Each gate can be setup in the sitemap to require a <em>role</em>. PHP Auth methods  can also be used in scripts where a particular role is required, though with  judicious use, the gate role is usually all that is needed.</p><p>Note that we us the term <em>role</em> which may imply a role-based system but  since all of the inner user-group-role workings are handled by custom functions  it does not matter to nexista what system is used. One could use a complex role  based system or a simple one password / one user, as desired.</p><p>To use the Authentication system, the developer needs to implement a custom  Login handler and optionally a Denied, Expired and Timeout handler in the prepend  file. If a user is not logged in and encounters a role requirement, the login  handler will be called. This handler is responsible for authenticating the user  in whatever manner is preferred, then calling the Auth::registerUser() method  with an array of allowed roles for this user.</p><p>If the session of a logged in user times out, expires or if the user encounters  a role they do not have, the Timeout, Expired and Denied handler will be called  respectively if setup. If the required handler is not setup, then it will default  to the Login handler.</p></p>
		<p class="notes">
			Located in <a class="field" href="_kernel---auth.php.html">/kernel/auth.php</a> (line <span class="field">44</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#NX_AUTH_STATUS_ACTIVE" title="details" class="const-name">NX_AUTH_STATUS_ACTIVE</a> = 					<span class="var-type"> 0</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#NX_AUTH_STATUS_EXPIRED" title="details" class="const-name">NX_AUTH_STATUS_EXPIRED</a> = 					<span class="var-type"> 3</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#NX_AUTH_STATUS_INACTIVE" title="details" class="const-name">NX_AUTH_STATUS_INACTIVE</a> = 					<span class="var-type"> 1</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#NX_AUTH_STATUS_TIMEOUT" title="details" class="const-name">NX_AUTH_STATUS_TIMEOUT</a> = 					<span class="var-type"> 2</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																								<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$sessionData" title="details" class="var-name">$sessionData</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																				<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#registerDeniedHandler" title="details" class="method-name">registerDeniedHandler</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#registerExpiredHandler" title="details" class="method-name">registerExpiredHandler</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#registerLoginHandler" title="details" class="method-name">registerLoginHandler</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#registerTimeoutHandler" title="details" class="method-name">registerTimeoutHandler</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
									</div>
																																																								<div class="method-definition">
					static 						<span class="method-result">object class</span>
										<a href="#singleton" title="details" class="method-name">singleton</a>
										()
									</div>
								
												<div class="method-definition">
											<span class="method-result">Auth</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#checkStatus" title="details" class="method-name">checkStatus</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#getSessionData" title="details" class="method-name">getSessionData</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">false</span>])
									</div>
																																																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#registerUser" title="details" class="method-name">registerUser</a>
											([<span class="var-type">array</span>&nbsp;<span class="var-name">$roles</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeUser" title="details" class="method-name">removeUser</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#requireRole" title="details" class="method-name">requireRole</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$role</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setSessionData" title="details" class="method-name">setSessionData</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setSessionName" title="details" class="method-name">setSessionName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$sessionData" id="$sessionData"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$sessionData</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">138</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">User session data</p>
<p class="description"><p>This array keeps track of certain items such as user roles,  if they are identified, what url they came from etc...  It is stored in sessions.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodregisterDeniedHandler" id="registerDeniedHandler"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method registerDeniedHandler</span> (line <span class="line-number">498</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers a function to be called on auth denied access</p>
<p class="description"><p>This function will be called when a user, who is already logged in  somehow, encounters a role beyond their access level.  It might be used to offer the user to upgrade their level or present  them with a denied screem.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			registerDeniedHandler
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$handler</span><span class="var-description">: function or an array of class=&gt;method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterExpiredHandler" id="registerExpiredHandler"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method registerExpiredHandler</span> (line <span class="line-number">516</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers a function to be called on auth session expiry</p>
<p class="description"><p>This function will be called when the user's session expires.  It might be used to reshow a login screen.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			registerExpiredHandler
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$handler</span><span class="var-description">: function or an array of class=&gt;method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterLoginHandler" id="registerLoginHandler"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method registerLoginHandler</span> (line <span class="line-number">479</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers a function to be called on auth login</p>
<p class="description"><p>This function will be called when the user needs a specific role  for an action and has not yet logged in.  It could be used to show a login screen or somehow inform user  that the action needs a special role.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			registerLoginHandler
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$handler</span><span class="var-description">: function or an array of class=&gt;method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterTimeoutHandler" id="registerTimeoutHandler"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method registerTimeoutHandler</span> (line <span class="line-number">534</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers a function to be called on auth session timeout</p>
<p class="description"><p>This function will be called when the user's session times out from inactivity.  It might be used to reshow a login screen.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			registerTimeoutHandler
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$handler</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$handler</span><span class="var-description">: function or an array of class=&gt;method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsingleton" id="singleton"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method singleton</span> (line <span class="line-number">396</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a class singleton.</p>
	<ul class="tags">
				<li><span class="field">return:</span> singleton instance</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">object class</span>
		<span class="method-name">
			singleton
		</span>
				()
			</div>
	
		
			
	</div>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">146</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor - Inits session, config</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Auth</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodcheckStatus" id="checkStatus"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">checkStatus</span> (line <span class="line-number">431</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks a user's current state</p>
<p class="description"><p>This method will return the current user status as a constant: <ul><li>Auth::NX_AUTH_STATUS_ACTIVE (user is logged in)</li><li>Auth::NX_AUTH_STATUS_EXPIRED (user session expired)</li><li>Auth::NX_AUTH_STATUS_TIMEOUT (user session timeout from inactivity)</li><li>Auth::NX_AUTH_STATUS_INACTIVE (user is not yet logged in)</li></ul></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			checkStatus
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSessionData" id="getSessionData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSessionData</span> (line <span class="line-number">364</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns user session data</p>
<p class="description"><p>If a variable name is passed, the value for it will  be returned. If no name is passed, the entire array will  be returned</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> value of requested variable, or whole session data</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			getSessionData
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: (optional) user session value name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterUser" id="registerUser"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">registerUser</span> (line <span class="line-number">325</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers a user with valid roles</p>
<p class="description"><p>This methid is used by the login handle to register (login)  the user with an array of allowed roles. These roles are called either in the  sitemap tag as:  <div class="src-code"><ol><li><div class="src-line"><span class="src-sym">&amp;</span><span class="src-id">lt</span><span class="src-sym">;</span><span class="src-id">map</span>:<span class="src-id">gate&nbsp;name</span>=<span class="src-sym">&amp;</span><span class="src-id">quot</span><span class="src-sym">;</span><span class="src-id">somegate</span><span class="src-sym">&amp;</span><span class="src-id">quot</span><span class="src-sym">;&nbsp;</span><span class="src-id">role</span>=<span class="src-sym">&amp;</span><span class="src-id">quot</span><span class="src-sym">;</span><span class="src-id">editArticle</span><span class="src-sym">&amp;</span><span class="src-id">quot</span><span class="src-sym">;</span><span class="src-sym">&amp;</span><span class="src-id">gt</span><span class="src-sym">;</span></div></li>
</ol></div>  or in a PHP script as:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$auth&nbsp;</span>=&nbsp;<span class="src-id"><a href="../Nexista/Auth.html">Auth</a></span><span class="src-sym">::</span><a href="../Nexista/Auth.html#methodsingleton">singleton</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-key">if</span><span class="src-sym">(</span><span class="src-id">auth</span>-<span class="src-sym">&amp;</span><span class="src-id">gt</span><span class="src-sym">;</span><a href="../Nexista/Auth.html#methodrequireRole">requireRole</a><span class="src-sym">(</span><span class="src-str">'someRole'</span><span class="src-sym">))</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-sym">{</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;...do&nbsp;<span class="src-id">my&nbsp;stuff</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> success</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			registerUser
		</span>
					([<span class="var-type">array</span>&nbsp;<span class="var-name">$roles</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$roles</span><span class="var-description">: User info to register with sessions</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveUser" id="removeUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removeUser</span> (line <span class="line-number">412</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Delete all session information and logout the user.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeUser
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodrequireRole" id="requireRole"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">requireRole</span> (line <span class="line-number">213</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Require that the user has a particular role</p>
<p class="description"><p>These roles are called using the sitemap tag as:  <div class="src-code"><ol><li><div class="src-line">&lt;<span class="src-id">map</span>:<span class="src-id">gate&nbsp;name</span>=<span class="src-str">&quot;somegate&quot;&nbsp;</span><span class="src-id">role</span>=<span class="src-str">&quot;editArticle&quot;</span>&gt;</div></li>
</ol></div>  or in a PHP script as:  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$auth&nbsp;</span>=&nbsp;<span class="src-id"><a href="../Nexista/Auth.html">Auth</a></span><span class="src-sym">::</span><a href="../Nexista/Auth.html#methodsingleton">singleton</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-key">if</span><span class="src-sym">(</span><span class="src-id">auth</span>-<span class="src-sym">&amp;</span><span class="src-id">gt</span><span class="src-sym">;</span><a href="../Nexista/Auth.html#methodrequireRole">requireRole</a><span class="src-sym">(</span><span class="src-str">'someRole'</span><span class="src-sym">))</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-sym">{</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;...do&nbsp;<span class="src-id">my&nbsp;stuff</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> if user has role permission</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			requireRole
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$role</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$role</span><span class="var-description">: role for this action/gate</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetSessionData" id="setSessionData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setSessionData</span> (line <span class="line-number">385</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets a user session data value</p>
<p class="description"><p>This method will set a variable value in the user session</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setSessionData
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: user session variable name</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: user session variable value</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetSessionName" id="setSessionName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setSessionName</span> (line <span class="line-number">347</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the auth session name</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setSessionName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: session name</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constNX_AUTH_STATUS_ACTIVE" id="NX_AUTH_STATUS_ACTIVE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">NX_AUTH_STATUS_ACTIVE</span>
			 = <span class="const-default"> 0</span>
			(line <span class="line-number">51</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">user status - logged in</p>
	
	
</div>
<a name="constNX_AUTH_STATUS_EXPIRED" id="NX_AUTH_STATUS_EXPIRED"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">NX_AUTH_STATUS_EXPIRED</span>
			 = <span class="const-default"> 3</span>
			(line <span class="line-number">72</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">user status - expired</p>
	
	
</div>
<a name="constNX_AUTH_STATUS_INACTIVE" id="NX_AUTH_STATUS_INACTIVE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">NX_AUTH_STATUS_INACTIVE</span>
			 = <span class="const-default"> 1</span>
			(line <span class="line-number">58</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">user status - inactive</p>
	
	
</div>
<a name="constNX_AUTH_STATUS_TIMEOUT" id="NX_AUTH_STATUS_TIMEOUT"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">NX_AUTH_STATUS_TIMEOUT</span>
			 = <span class="const-default"> 2</span>
			(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">user status - timed out</p>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Thu, 02 Aug 2007 17:35:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
	</p>
	</div></body>
</html>